﻿#region Licence
// <copyright file="Interfaces/IAccessControlLayer.cs" company="Kopigi">
// Copyright © Kopigi 2014
// </copyright>
// ****************************************************************************
// <author>Marc PLESSIS</author>
// <date>10/10/2014</date>
// <project>Nentang.wpf</project>
// <web>http://nentang.codeplex.com</web>
// <license>
// The MIT License (MIT)
// 
// Copyright (c) 2013 Marc Plessis
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// 
// </license>
#endregion
#region using

using System.Collections.Generic;
using Database.POCO;
using Interfaces.Contracts;
using Interfaces.Enums;

#endregion

namespace Interfaces
{
    /// <summary>
    /// Interface de gestion des droits d'accés
    /// </summary>
    public interface IServiceAccessControlLayer
    {
        /// <summary>
        /// Utilisateur connecté actuellement
        /// </summary>
        SysUtilisateur CurrentUser { get; set; }

        /// <summary>
        /// Liste des modules concernés par les drtois
        /// </summary>
        List<IModuleMetadata> Modules { get; set; } 

        /// <summary>
        /// Permet d'authentifier un utilisateur
        /// </summary>
        /// <param name="user">Nom d'utilisateur</param>
        /// <param name="password">Mot de passe</param>
        /// <param name="errorsEnum">Erreur éventuelle qui pourrait resortir de l'authentification</param>
        /// <returns>true dans le cas d'une authentification correct, sinon false</returns>
        bool IsAuth(string user, string password, out AccessControlErrorsEnum errorsEnum);

        /// <summary>
        /// Vérifie que l'utilisateur courant à le droit d'accéder à la fonction voulue
        /// </summary>
        /// <param name="identifiantDroit">Identifiant du droit voulu</param>
        /// <param name="retrieveValuesRight">Indique si l'on doit charger les droits accordés à l'utilisateur courant pour la fonction voulue</param>
        /// <returns>true si les droits sont accordés, sinon false</returns>
        bool IsAuthorizedFunction(string identifiantDroit, bool retrieveValuesRight = false);

        /// <summary>
        /// Vérifie que l'utilisateur courant à le droit d'accéder à la fonction voulue
        /// </summary>
        /// <param name="identifiantDroit">Identifiant du droit voulu</param>
        /// <param name="rights">Charge la valeur de droit accordé à l'utilisateur courant pour la fonction voulue</param>
        /// <returns>true si les droits sont accordés, sinon false</returns>
        bool IsAuthorizedFunction(string identifiantDroit, out ValueRightsEnum rights);

        /// <summary>
        /// Déconnecte l'utilisateur courant
        /// </summary>
        /// <returns>Indique si l'opération s'est correctement déroulée</returns>
        bool Disconnect();

        /// <summary>
        /// Permet de créer un nouveau mot de passe pour un utilisateur
        /// </summary>
        /// <param name="user">Utilisateur à modifier</param>
        /// <param name="password">Mot de passe à créer</param>
        /// <param name="save">Indique si l'enregistrement du mot de passe en base de données doit se faire immédiatement</param>
        /// <returns>Indique si l'opération s'est correctement déroulée</returns>
        bool CreateNewPasswordForUser(SysUtilisateur user, string password, bool save= false);

        /// <summary>
        /// Retourne la valeur associée à un droit pour l'utilisateur courant
        /// </summary>
        /// <param name="identifiantDroit">Identifiant du droit voulu</param>
        /// <returns>Valeur des droits</returns>
        ValueRightsEnum ValueAuthorizedFunction(string identifiantDroit);

        /// <summary>
        /// Permet de savoir si l'utilisateur courant est autorisé à visualiser la colonne voulues de la table spécifiée
        /// </summary>
        /// <param name="table">Table</param>
        /// <param name="column">Colonne</param>
        /// <returns>true si l'utilisateur courant peut visualiser la colonne, sinon false</returns>
        bool IsAuthorizedToVisualizedColumns(string table, string column);

        /// <summary>
        /// Retourne la valeur associée à une colonne de table pour l'utilisateur courant
        /// </summary>
        /// <param name="table">Table</param>
        /// <param name="column">Colonne</param>
        /// <returns>Valeur des droits</returns>
        ValueRightsEnum ValueAuthorizedColumns(string table, string column);
    }
}
